home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / filutil / shidx10.zip / shidx.doc < prev    next >
Text File  |  1994-12-20  |  7KB  |  145 lines
  1.                *****  Search Index v1.0 by Lonny Jacobson  *****
  2.  
  3.                              December 20, 1994
  4.  
  5. Introduction:
  6.  
  7.      Have you ever downloaded the file SIMIBM.LST from a SimTel mirror?  While
  8. this index and others like it are useful for finding specific files, a program
  9. like grep doesn't reveal the "directory" line.  That's why I wrote this simple
  10. program.  Unlike grep, however, my program displays the "directory" line (or the
  11. location of the file).
  12.  
  13.      This program may be freely distributed as freeware because I just don't 
  14. have the heart to charge money -- besides, this is my first program to be 
  15. released upon the Internet :-)
  16.  
  17.      Please send your comments, suggestions, constructive criticisms to
  18. ljacobso@nyx.cs.du.edu.
  19.  
  20. -------------------------------------------------------------------------------
  21. Demonstration:
  22.  
  23.      If all of this seems unclear then let me demonstrate:
  24.  
  25. C:>grep -i multithread \files\dirs\simdos.lst
  26.  
  27. mtl110je.zip  B  148021  930722  DOS multithreading library for Borland C++
  28.  
  29. Total Program Time: 0:0:2.25
  30.  
  31.  
  32. C:>shidx /Wmultithread /I \files\dirs\simdos.lst
  33.  
  34. Searching in c:\files\dirs\simdos.lst
  35.  
  36. Directory SimTel/msdos/cpluspls/ C++ programming language-related files
  37. mtl110je.zip  B  148021  930722  DOS multithreading library for Borland C++
  38.  
  39. Total Program Time: 0:0:4.50
  40.  
  41.  
  42.      As you can see, grep only displays the line that contains "multithread".
  43. My program includes the "Directory" line which contains the location of
  44. mtl110je.zip.
  45.  
  46. -------------------------------------------------------------------------------
  47. Command Line:
  48.  
  49.      The defaults for this program are setup for SIMIBM.LST.  Shidx
  50. automatically reads shidx.dat before doing anything.  This file need not be
  51. present.
  52.  
  53. /C<label>                 Only search in header: <label>
  54.                           Program only looks in label containing <label> for
  55.                           words.
  56.                           Example:
  57.                           /Cpascal -- only searches in labels containing pascal
  58.                                       Case-Insensitive
  59.  
  60. -------------------------------------------------------------------------------
  61. /D<label>,<nnn>           Look for header: <label> at column: <nnn>
  62.                           Labels are defined by <label> beginning at column
  63.                           <nnn>.  Case-insensitive.
  64.                           Examples:
  65.                           /DDirectory,1 -- Default for simibm.lst
  66.                           /D            -- Don't use labels (same as grep)
  67.  
  68. -------------------------------------------------------------------------------
  69. /F<filename>              Save output to file: <filename>
  70.                           Output is redirected to file.
  71.                           Examples:
  72.                           /FOutput.txt -- Writes everything to OUTPUT.TXT.
  73.                           /F           -- Writes everything to (default) file
  74.                                           SEARCH.TXT.
  75.  
  76. -------------------------------------------------------------------------------
  77. /I                        Case-insensitive search
  78.                           Performs a case-insensitive search in all files
  79.                           Example:
  80.                           /I- -- Negates previously defined sensitivity.
  81.  
  82. -------------------------------------------------------------------------------
  83. /N<n>                     Print output to LPT<n>
  84.                           Output is redirected to printer at LPT<n>.  <n> has
  85.                           a value of 1, 2, or 3.
  86.                           Examples:
  87.                           /N3 -- Prints output to LPT3.
  88.                           /N  -- Prints output to (default) LPT1.
  89.  
  90. -------------------------------------------------------------------------------
  91. /P<nnn>                   Pause every <nnn> lines of output
  92.                           Waits for the user to continue searching after <nnn>
  93.                           lines of output.
  94.                           Examples:
  95.                           /P43 -- Pauses output after 43 lines.
  96.                           /P   -- Pauses output after (default) 24 lines.
  97.  
  98. -------------------------------------------------------------------------------
  99. /S                        Show current search parameters
  100.                           Example:
  101.                           /S -- Displays information at beginning of search.
  102.  
  103. -------------------------------------------------------------------------------
  104. /W<word>[, & * ?]...      List of keywords
  105.                           Program searches each line of text for keyword(s).
  106.                           , = or line contains this word
  107.                           & = and line contains this word
  108.                           * = and remaining line contains word
  109.                           ? = and remaining line contains unknown character(s)
  110.                               then word
  111.                           Example:
  112.                           /Ws???x&Lo*y,multithread
  113.  
  114. -------------------------------------------------------------------------------
  115. /X<x1>,<x2>               Search between column: <x1> and column: <x2>
  116.                           Examples:
  117.                           /X5,75 -- Looks between 5 and 75 for words
  118.                           /X     -- Looks between (default) 1 and 80 for words
  119.  
  120. -------------------------------------------------------------------------------
  121. /Y                        Prompts for all values
  122.                           Example:
  123.                           /Y -- Program prompts program for all command line
  124.                                 options.  Good for beginners.
  125.  
  126. -------------------------------------------------------------------------------
  127. /Z,0...9<filename>        Use variables or file: <filename> for values
  128.                           Environment variables are usually set in the
  129.                           AUTOEXEC.BAT
  130.                           Examples:
  131.                           SET SHIDXDEF=/DINDEX,1 BORLAND.LST /X1,90
  132.                           /Z -- Reads values from environment variable SHIDXDEF
  133.                           /1 -- Reads values from variable SHIDXDEF1
  134.                           /0shidx.def -- Reads values from file SHIDX.DEF.
  135.                                          Each option occuppies one line:
  136.                                          /DINDEX,1
  137.                                          borland.lst
  138.                                          /X1,90
  139. -------------------------------------------------------------------------------
  140.  
  141.  
  142. Please send your comments AND suggestions to ljacobso@nyx.cs.du.edu.
  143.  
  144. Thank you
  145.